home *** CD-ROM | disk | FTP | other *** search
/ The Atari Compendium / The Atari Compendium (Toad Computers) (1994).iso / files / umich / utils / whati~gz.zoo / whatis.1z / whatis
Text File  |  1992-09-12  |  2KB  |  53 lines
  1.  
  2. NAME
  3.     whatis - show description of word
  4.  
  5. SYNOPSIS
  6.     whatis [ -l ] [ -P path ] [ -s section ] word...
  7.  
  8. DESCRIPTION
  9.     The  whatis  command displays a one line synopsis of each online
  10.     documentation file whose name matches the specified  word.    To
  11.     read the actual online documentation, use the man(1) command.
  12.  
  13.     Word is considered separately from each other word.  The case of
  14.     letters is significant.
  15.  
  16. OPTIONS
  17.     The following switch options are recognized:
  18.  
  19.     -l    a more verbose (long) output is given containing the one
  20.         line   description   plus  a  list  of  keywords,  cross
  21.         references, and the primary manual page, if any.
  22.  
  23.     -P path
  24.         if a valid  path  is  given,  whatis  searches  for  the
  25.         databases there (see ENVIRONMENT).
  26.  
  27.     -s section
  28.         search only  for items from the specified section.  This
  29.         should be a single character representing a  section  of
  30.         the manual, i.e., from the list:
  31.         
  32.             0123456789lno
  33.  
  34. ENVIRONMENT
  35.     Whatis searches for the database file in the directory contained
  36.     in the  MANPATH  environment  variable.  Note that the -P option
  37.     overrides this.  If neither  MANPATH  or  -P  are  specified,  a
  38.     default path of ``d:/usr/man'' is used.
  39.  
  40. FILES
  41.     MANPATH/whatis._?_    online documentation database file
  42.  
  43. SEE ALSO
  44.     apropos(1), man(1), whatisin(1), whereis(1)
  45.  
  46. AUTHOR
  47.     Bill Rosenkranz
  48.     rosenkra@convex.com
  49.  
  50. VERSION
  51.     whatis v2.0.1 92/9/12 rosenkra
  52.  
  53.